Quantification and Analytics Tool (2.12.0)
Download OpenAPI specification:Download
API's to access the QAT Server
Update Budget
API used to update a Budget
Request Body schema: application/jsonrequired
The Budget object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| budgetId | integer <int32> |
| budgetCode | string |
object (SimpleCodeObject) | |
object (FundingSource) | |
object (Label) | |
object (Currency) | |
| budgetAmt | number <double> |
| budgetUsdAmt | number <double> |
| usedUsdAmt | number <double> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| notes | string |
| budgetUsable | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "budgetId": 0,
- "budgetCode": "string",
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "fundingSource": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "fundingSourceId": 0,
- "fundingSourceCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "allowedInBudget": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "budgetAmt": 0.1,
- "budgetUsdAmt": 0.1,
- "usedUsdAmt": 0.1,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "notes": "string",
- "budgetUsable": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Budget
API used to add a Budget to the Realm
Request Body schema: application/jsonrequired
The Budget object that you want to add to the Realm
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| budgetId | integer <int32> |
| budgetCode | string |
object (SimpleCodeObject) | |
object (FundingSource) | |
object (Label) | |
object (Currency) | |
| budgetAmt | number <double> |
| budgetUsdAmt | number <double> |
| usedUsdAmt | number <double> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| notes | string |
| budgetUsable | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "budgetId": 0,
- "budgetCode": "string",
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "fundingSource": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "fundingSourceId": 0,
- "fundingSourceCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "allowedInBudget": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "budgetAmt": 0.1,
- "budgetUsdAmt": 0.1,
- "usedUsdAmt": 0.1,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "notes": "string",
- "budgetUsable": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Commit Request for Supply Plan
API used Part 1 of the Commit Request for Supply Plan.
path Parameters
| comparedVersionId required | integer <int32> comparedVersionId that you want to commit supply plan for |
Request Body schema: application/jsonrequired
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
object (SimpleObject) | |
object (SimpleObject) | |
| notes | string |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
Array of objects (Consumption) | |
Array of objects (Inventory) | |
Array of objects (Shipment) | |
Array of objects (Batch) | |
Array of objects (ProblemReport) | |
Array of objects (SimplifiedSupplyPlan) | |
| requestedProgramVersion | integer <int32> |
Array of objects (SimplePlanningUnitForSupplyPlanObject) | |
Array of objects (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "consumptionList": [
- {
- "consumptionId": 0,
- "region": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "idString": "string"
}, - "idString": "string"
}, - "realmCountryPlanningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "alternateReportingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "multiplier": 0.1,
- "conversionFactor": 0.1,
- "consumptionDate": "string",
- "actualFlag": true,
- "consumptionRcpuQty": 0.1,
- "consumptionQty": 0.1,
- "dayOfStockOut": 0,
- "dataSource": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "versionId": 0,
- "batchInfoList": [
- {
- "consumptionTransBatchInfoId": 0,
- "batch": {
- "batchId": 0,
- "batchNo": "string",
- "autoGenerated": true,
- "planningUnitId": 0,
- "expiryDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z"
}, - "consumptionQty": 0.1
}
], - "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true
}
], - "inventoryList": [
- {
- "inventoryId": 0,
- "inventoryDate": "string",
- "region": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "realmCountryPlanningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "alternateReportingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "idString": "string"
}, - "idString": "string"
}, - "multiplier": 0.1,
- "conversionFactor": 0.1,
- "actualQty": 0.1,
- "adjustmentQty": 0.1,
- "expectedBal": 0.1,
- "dataSource": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "versionId": 0,
- "batchInfoList": [
- {
- "inventoryTransBatchInfoId": 0,
- "batch": {
- "batchId": 0,
- "batchNo": "string",
- "autoGenerated": true,
- "planningUnitId": 0,
- "expiryDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z"
}, - "adjustmentQty": 0.1,
- "actualQty": 0.1
}
], - "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true
}
], - "shipmentList": [
- {
- "shipmentId": 0,
- "parentShipmentId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "idString": "string"
}, - "idString": "string"
}, - "expectedDeliveryDate": "string",
- "suggestedQty": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "colorHtmlCode": "string",
- "idString": "string"
}, - "budget": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "currency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "fundingSource": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "procurementUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "supplier": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "shipmentQty": 0,
- "conversionFactor": 0.1,
- "rate": 0.1,
- "currency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCost": 0.1,
- "shipmentMode": "string",
- "freightCost": 0.1,
- "plannedDate": "string",
- "submittedDate": "string",
- "approvedDate": "string",
- "shippedDate": "string",
- "arrivedDate": "string",
- "receivedDate": "string",
- "shipmentStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "dataSource": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "accountFlag": true,
- "erpFlag": true,
- "orderNo": "string",
- "primeLineNo": "string",
- "emergencyOrder": true,
- "localProcurement": true,
- "versionId": 0,
- "batchInfoList": [
- {
- "shipmentTransBatchInfoId": 0,
- "batch": {
- "batchId": 0,
- "batchNo": "string",
- "autoGenerated": true,
- "planningUnitId": 0,
- "expiryDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z"
}, - "shipmentQty": 0
}
], - "active": true,
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z"
}
], - "batchInfoList": [
- {
- "batchId": 0,
- "batchNo": "string",
- "autoGenerated": true,
- "planningUnitId": 0,
- "expiryDate": "2019-08-24T14:15:22Z",
- "createdDate": "2019-08-24T14:15:22Z"
}
], - "problemReportList": [
- {
- "problemReportId": 0,
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "versionId": 0,
- "realmProblem": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmProblemId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "problem": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "problemId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "problemCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "actionUrl": "string",
- "actionLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "actualConsumptionTrigger": true,
- "forecastedConsumptionTrigger": true,
- "inventoryTrigger": true,
- "adjustmentTrigger": true,
- "shipmentTrigger": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "criticality": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "colorHtmlCode": "string",
- "idString": "string"
}, - "data1": "string",
- "data2": "string",
- "data3": "string",
- "problemType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "dt": "string",
- "region": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "shipmentId": 0,
- "data5": "string",
- "problemCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "problemStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "problemType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "reviewed": true,
- "reviewNotes": "string",
- "reviewedDate": "2019-08-24T14:15:22Z",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "problemTransList": [
- {
- "problemReportTransId": 0,
- "problemStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "reviewed": true,
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z"
}
]
}
], - "supplyPlan": [
- {
- "supplyPlanId": 0,
- "programId": 0,
- "versionId": 0,
- "planningUnitId": 0,
- "conversionFactor": 0.1,
- "transDate": "string",
- "actualFlag": true,
- "consumptionQty": 0,
- "receivedShipmentsTotalData": 0,
- "shippedShipmentsTotalData": 0,
- "approvedShipmentsTotalData": 0,
- "submittedShipmentsTotalData": 0,
- "plannedShipmentsTotalData": 0,
- "onholdShipmentsTotalData": 0,
- "receivedErpShipmentsTotalData": 0,
- "shippedErpShipmentsTotalData": 0,
- "approvedErpShipmentsTotalData": 0,
- "submittedErpShipmentsTotalData": 0,
- "plannedErpShipmentsTotalData": 0,
- "onholdErpShipmentsTotalData": 0,
- "stockQty": 0,
- "adjustmentQty": 0,
- "regionCount": 0,
- "regionCountForStock": 0,
- "amc": 0.1,
- "amcCount": 0,
- "minStock": 0.1,
- "minStockMoS": 0.1,
- "maxStock": 0.1,
- "maxStockMoS": 0.1,
- "batchDetails": [
- {
- "batchId": 0,
- "batchNo": "string",
- "expiryDate": "2019-08-24T14:15:22Z",
- "autoGenerated": true,
- "qty": 0,
- "qtyWps": 0,
- "expiredQty": 0,
- "expiredQtyWps": 0,
- "consumptionQty": 0,
- "stockQty": 0,
- "adjustmentQty": 0,
- "shipmentQty": 0,
- "shipmentQtyWps": 0,
- "unallocatedQty": 0,
- "unallocatedQtyWps": 0,
- "openingBalance": 0,
- "openingBalanceWps": 0,
- "createdDate": "2019-08-24T14:15:22Z"
}
], - "expiredStock": 0,
- "expiredStockWps": 0,
- "unmetDemand": 0,
- "unmetDemandWps": 0,
- "openingBalance": 0,
- "openingBalanceWps": 0,
- "closingBalance": 0,
- "closingBalanceWps": 0,
- "nationalAdjustment": 0,
- "nationalAdjustmentWps": 0,
- "mos": 0.1,
- "mosWps": 0.1,
- "shipmentTotalQty": 0,
- "manualTotalQty": 0,
- "erpTotalQty": 0
}
], - "requestedProgramVersion": 0,
- "planningUnitList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "active": true,
- "conversionFactor": 0.1,
- "procurementAgentSkuList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "skuCode": "string",
- "active": true,
- "idString": "string"
}
], - "monthsInFutureForAmc": 0,
- "monthsInPastForAmc": 0,
- "reorderFrequencyInMonths": 0,
- "minMonthsOfStock": 0,
- "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "idString": "string"
}
], - "procurementAgentList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get Commit Request list
API used get supply plan commit request list .
path Parameters
| requestStatus required | integer <int32> requestStatus that you want to commit request list for |
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programIds | Array of strings |
| programIdsString | string |
| startDateString | string |
| stopDateString | string |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programIds": [
- "string"
], - "programIdsString": "string",
- "startDateString": "string",
- "stopDateString": "string"
}Update Country
API used to update a Country
Request Body schema: application/jsonrequired
The Country object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| countryId | integer <int32> |
| countryCode | string |
| countryCode2 | string |
object (Label) | |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Country
API used to add a Country
Request Body schema: application/jsonrequired
The Country object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| countryId | integer <int32> |
| countryCode | string |
| countryCode2 | string |
object (Label) | |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update Currency
API used to update a Currency
Request Body schema: application/jsonrequired
The Currency object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| currencyId | integer <int32> |
| currencyCode | string |
object (Label) | |
| conversionRateToUsd | number <double> |
| isSync | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Currency
API used to add a Currency
Request Body schema: application/jsonrequired
The Currency object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| currencyId | integer <int32> |
| currencyCode | string |
object (Label) | |
| conversionRateToUsd | number <double> |
| isSync | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update DataSource
API used to update a DataSource
Request Body schema: application/jsonrequired
The DataSource object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dataSourceId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dataSourceId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "dataSourceType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add DataSource
API used to add a DataSource
Request Body schema: application/jsonrequired
The DataSource object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dataSourceId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dataSourceId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "dataSourceType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update DataSourceType
API used to update a DataSourceType
Request Body schema: application/jsonrequired
The DataSourceType object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dataSourceTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dataSourceTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add DataSourceType
API used to add a DataSourceType
Request Body schema: application/jsonrequired
The DataSourceType object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dataSourceTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dataSourceTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get dataset list for programId and versionId
API used to get the dataset list for specific programId and versionId.
path Parameters
| programId required | integer <int32> programId that you want to the dataset list for |
| versionId required | integer <int32> versionId that you want to the dataset list for |
Responses
Get dataset list for multiple programId and versionId
API used to get the dataset list for multiple programId and versionId.
Request Body schema: application/jsonrequired
map of programVersionList that you want to the dataset list for
| programId | integer <int32> |
| versionId | integer <int32> |
Responses
Request samples
- Payload
[- {
- "programId": 0,
- "versionId": 0
}
]Update dataset
API used to update a dataset
Request Body schema: application/jsonrequired
The dataset object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| programTypeId | integer <int32> |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
| healthAreaArray | Array of strings |
| regionArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "programTypeId": 0,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "healthAreaArray": [
- "string"
], - "regionArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get planning unit list for programId and versionId
API used to get the planning unit list for specific programId and versionId.
path Parameters
| programId required | integer <int32> programId that you want to the planning unit list for |
| versionId required | integer <int32> versionId that you want to the planning unit list for |
Responses
List five versions of program from given page number for specified programId
API used to list five versions of dataset from given page number for specified programId
path Parameters
| programId required | integer <int32> programId that you want to get dataset list for |
| page required | integer <int32> number that you want to get dataset list from |
Responses
Add datatset
API used to add a datatset
Request Body schema: application/jsonrequired
The dataset object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| programTypeId | integer <int32> |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
| healthAreaArray | Array of strings |
| regionArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "programTypeId": 0,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "healthAreaArray": [
- "string"
], - "regionArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update Dimension
API used to update a Dimension
Request Body schema: application/jsonrequired
The Dimension object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dimensionId | integer <int32> |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dimensionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Dimension
API used to add a Dimension
Request Body schema: application/jsonrequired
The Dimension object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| dimensionId | integer <int32> |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "dimensionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add or Update EquivalencyUnit
API used to add or update EquivalencyUnit
Request Body schema: application/jsonrequired
The list of EquivalencyUnit objects that you want to add or update. If equivalencyUnitId is null or 0 then it is added if equivalencyUnitId is not null and non 0 it is updated
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| equivalencyUnitId | integer <int32> |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "equivalencyUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Add or Update EquivalencyUnitMapping
API used to add or update EquivalencyUnitMapping
Request Body schema: application/jsonrequired
The list of EquivalencyUnitMapping objects that you want to add or update. If equivalencyUnitMappingId is null or 0 then it is added if equivalencyUnitMappingId is not null and non 0 it is updated
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| equivalencyUnitMappingId | integer <int32> |
object (EquivalencyUnit) | |
object (SimpleObject) | |
object (SimpleCodeObject) | |
object (SimpleObject) | |
| convertToEu | number <double> |
| notes | string |
object (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "equivalencyUnitMappingId": 0,
- "equivalencyUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "equivalencyUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "convertToEu": 0.1,
- "notes": "string",
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Get list of EquivalencyUnitMapping
API used to get the list of Equivalency Units Mapping based on a Program and a Forecasting Unit
path Parameters
| forecastingUnitId required | integer <int32> The Forecasting Unit Id that you want the list of EUM for |
| programId required | integer <int32> The Program Id that you want the priority for |
Responses
Add or Update ForecastMethod
API used to add or update ForecastMethod
Request Body schema: application/jsonrequired
The list of ForecastMethod objects that you want to add or update. If forecastMethodId is null or 0 then it is added if forecastMethodId is not null and non 0 it is updated
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| forecastMethodId | integer <int32> |
| forecastMethodTypeId | integer <int32> |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastMethodId": 0,
- "forecastMethodTypeId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Update ForecastingUnit
API used to update a ForecastingUnit
Request Body schema: application/jsonrequired
The ForecastingUnit object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| forecastingUnitId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (Label) | |
object (SimpleObject) | |
object (SimpleObject) | |
object (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add ForecastingUnit
API used to add a ForecastingUnit
Request Body schema: application/jsonrequired
The ForecastingUnit object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| forecastingUnitId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (Label) | |
object (SimpleObject) | |
object (SimpleObject) | |
object (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get ForecastingUnit for a multiple tracer categories
API used to get forecastingUnits for multiple tracer categories
Request Body schema: application/jsonrequired
array of tracerCategoryIds that you want to the ForecastingUnit for
Responses
Request samples
- Payload
[- "string"
]Get forecasting unit for specific ProgramId and versionId
API used to get the forecasting unit for a specific ProgramId and versionId
path Parameters
| programId required | integer <int32> programId that you want to the forecasting unit for |
| versionId required | integer <int32> versionId that you want to the forecasting unit for |
Responses
Update FundingSource
API used to update a FundingSource
Request Body schema: application/jsonrequired
The FundingSource object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| fundingSourceId | integer <int32> |
| fundingSourceCode | string |
object (Label) | |
object (SimpleCodeObject) | |
| allowedInBudget | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "fundingSourceId": 0,
- "fundingSourceCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "allowedInBudget": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add FundingSource
API used to add a FundingSource
Request Body schema: application/jsonrequired
The FundingSource object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| fundingSourceId | integer <int32> |
| fundingSourceCode | string |
object (Label) | |
object (SimpleCodeObject) | |
| allowedInBudget | boolean |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "fundingSourceId": 0,
- "fundingSourceCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "allowedInBudget": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get FundingSource by display name
API used to get the complete FundingSource by providing the display name of the FundingSource and the Realm
path Parameters
| realmId required | integer <int32> RealmId that you want to the FundingSource for |
| name required | string Display name that you want to the FundingSource for |
Responses
Update HealthArea
API used to update a HealthArea
Request Body schema: application/jsonrequired
The HealthArea object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| healthAreaId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
| healthAreaCode | string |
| realmCountryArray | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "healthAreaId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaCode": "string",
- "realmCountryArray": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add HealthArea
API used to add a HealthArea
Request Body schema: application/jsonrequired
The HealthArea object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| healthAreaId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
| healthAreaCode | string |
| realmCountryArray | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "healthAreaId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaCode": "string",
- "realmCountryArray": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get HealthArea by display name
API used to get the complete HealthArea by providing the display name of the HealthArea and the Realm
path Parameters
| realmId required | integer <int32> RealmId that you want to the HealthArea for |
| name required | string Display name that you want to the HealthArea for |
Responses
Update IntegrationProgram
API used to update an IntegrationProgram
Request Body schema: application/jsonrequired
An array of Integration Program objects that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| integrationProgramId | integer <int32> |
object (Integration) | |
object (SimpleObject) | |
object (SimpleObject) | |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "integrationProgramId": 0,
- "integration": {
- "integrationId": 0,
- "integrationName": "string",
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "folderLocation": "string",
- "fileName": "string",
- "integrationView": {
- "integrationViewId": 0,
- "integrationViewDesc": "string",
- "integrationViewName": "string"
}
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Update Integration
API used to update an Integration
Request Body schema: application/jsonrequired
The Integration object that you want to update
| integrationId | integer <int32> |
| integrationName | string |
object (SimpleObject) | |
| folderLocation | string |
| fileName | string |
object (IntegrationView) |
Responses
Request samples
- Payload
{- "integrationId": 0,
- "integrationName": "string",
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "folderLocation": "string",
- "fileName": "string",
- "integrationView": {
- "integrationViewId": 0,
- "integrationViewDesc": "string",
- "integrationViewName": "string"
}
}Add Integration
API used to add an Integration
Request Body schema: application/jsonrequired
The Integration object that you want to add
| integrationId | integer <int32> |
| integrationName | string |
object (SimpleObject) | |
| folderLocation | string |
| fileName | string |
object (IntegrationView) |
Responses
Request samples
- Payload
{- "integrationId": 0,
- "integrationName": "string",
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "folderLocation": "string",
- "fileName": "string",
- "integrationView": {
- "integrationViewId": 0,
- "integrationViewDesc": "string",
- "integrationViewName": "string"
}
}Add attachment in Jira issue
API used to add attachment in the issue in Jira
path Parameters
| issueId required | string Issue id for which attachment needs to be added for |
Request Body schema: application/json
Attachment which needs to be added in Jira issue
| file | string <binary> |
Responses
Request samples
- Payload
{- "file": "string"
}Update Language
API used to update a Language
Request Body schema: application/jsonrequired
The Language object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| languageId | integer <int32> |
object (Label) | |
| languageCode | string |
| countryCode | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "languageId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "languageCode": "string",
- "countryCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Language
API used to add a Language
Request Body schema: application/jsonrequired
The Language object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| languageId | integer <int32> |
object (Label) | |
| languageCode | string |
| countryCode | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "languageId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "languageCode": "string",
- "countryCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add or Update ModelingType
API used to add or update ModelingType
Request Body schema: application/jsonrequired
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| modelingTypeId | integer <int32> |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "modelingTypeId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Update Organisation
API used to update an Organisation
Request Body schema: application/jsonrequired
The Organisation object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| organisationId | integer <int32> |
| organisationCode | string |
object (SimpleCodeObject) | |
object (SimpleObject) | |
object (Label) | |
| realmCountryArray | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "organisationId": 0,
- "organisationCode": "string",
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "organisationType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountryArray": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Organisation
API used to add an Organisation
Request Body schema: application/jsonrequired
The Organisation object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| organisationId | integer <int32> |
| organisationCode | string |
object (SimpleCodeObject) | |
object (SimpleObject) | |
object (Label) | |
| realmCountryArray | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "organisationId": 0,
- "organisationCode": "string",
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "organisationType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountryArray": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get Organisation by display name
API used to get the complete Organisation by providing the display name of the Organisation and the Realm
path Parameters
| realmId required | integer <int32> RealmId that you want to the Organisation for |
| name required | string Display name that you want to the Organisation for |
Responses
Update Organisation Type
API used to update an Organisation type
Request Body schema: application/jsonrequired
The OrganisationType object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| organisationTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "organisationTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Organisation Type
API used to add an Organisation Type
Request Body schema: application/jsonrequired
The OrganisationType object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| organisationTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "organisationTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Save Pipeline Program Data
API used to save pipeline program data into QAT temp tables
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need to save program for |
Request Body schema: application/jsonrequired
Program object which you need to save in temp table
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| monthsInPastForAmc | integer <int32> |
| monthsInFutureForAmc | integer <int32> |
| shelfLife | number <double> |
Array of objects (Region) | |
| regionArray | Array of strings |
object (Version) | |
Array of objects (Version) | |
| healthAreaArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "monthsInPastForAmc": 0,
- "monthsInFutureForAmc": 0,
- "shelfLife": 0.1,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "regionArray": [
- "string"
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "healthAreaArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Save Shipment Data For Program
API used to save shipment for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need shipment to save for |
Request Body schema: application/jsonrequired
Array of shipments which needs to be saved
| shipmentId | integer <int32> |
| planningUnit | string |
| expectedDeliveryDate | string <date-time> |
| suggestedQty | number <double> |
| procurementAgent | string |
| procurementUnit | string |
| supplier | string |
| quantity | number <double> |
| rate | number <double> |
| productCost | number <double> |
| shipmentMode | string |
| freightCost | number <double> |
| plannedDate | string <date-time> |
| submittedDate | string <date-time> |
| approvedDate | string <date-time> |
| shippedDate | string <date-time> |
| arrivedDate | string <date-time> |
| receivedDate | string <date-time> |
| shipmentStatus | string |
| notes | string |
| dataSource | string |
| accountFlag | boolean |
| erpFlag | boolean |
| versionId | integer <int32> |
| fundingSource | string |
| active | boolean |
Responses
Request samples
- Payload
[- {
- "shipmentId": 0,
- "planningUnit": "string",
- "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "suggestedQty": 0.1,
- "procurementAgent": "string",
- "procurementUnit": "string",
- "supplier": "string",
- "quantity": 0.1,
- "rate": 0.1,
- "productCost": 0.1,
- "shipmentMode": "string",
- "freightCost": 0.1,
- "plannedDate": "2019-08-24T14:15:22Z",
- "submittedDate": "2019-08-24T14:15:22Z",
- "approvedDate": "2019-08-24T14:15:22Z",
- "shippedDate": "2019-08-24T14:15:22Z",
- "arrivedDate": "2019-08-24T14:15:22Z",
- "receivedDate": "2019-08-24T14:15:22Z",
- "shipmentStatus": "string",
- "notes": "string",
- "dataSource": "string",
- "accountFlag": true,
- "erpFlag": true,
- "versionId": 0,
- "fundingSource": "string",
- "active": true
}
]Save Planning Unit For Realm Country
API used to save planning unit for specified realm country
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need planning unit to save for |
| realmCountryId required | integer <int32> realmCountryId for which you need planning unit to save for |
Responses
Save Pipeline Data
API used to save pipeline db data in to QAT adb(access database) tables
path Parameters
| fileName required | string Filename to save in database |
Request Body schema: application/jsonrequired
Pipeline object which you need to save in adb tables
Array of objects (PplCommodityprice) | |
Array of objects (PplConsumption) | |
Array of objects (PplDatasource) | |
Array of objects (PplFundingsource) | |
Array of objects (PplInventory) | |
Array of objects (PplMethod) | |
Array of objects (PplMonthlystockarchive) | |
Array of objects (PplPasterrors) | |
Array of objects (PplProduct) | |
Array of objects (PplProductfreightcost) | |
Array of objects (PplProductsuppliercasesize) | |
Array of objects (PplPrograminfo) | |
Array of objects (PplShipment) | |
Array of objects (PplSource) | |
Array of objects (PplTblbe_version) | |
Array of objects (PplTblimportproducts) | |
Array of objects (PplTblimportrecords) |
Responses
Request samples
- Payload
{- "commodityprice": [
- {
- "productid": "string",
- "supplierid": "string",
- "dtmeffective": "2019-08-24T14:15:22Z",
- "unitprice": 0.1,
- "dtmchanged": "2019-08-24T14:15:22Z",
- "user": "string",
- "note": "string",
- "fuserdefined": true,
- "pipelineId": 0
}
], - "consumption": [
- {
- "productid": "string",
- "consstartyear": 0,
- "consstartmonth": 0,
- "consactualflag": true,
- "consnummonths": 0,
- "consamount": 0.1,
- "consdatasourceid": "string",
- "consiflator": 0.1,
- "consnote": "string",
- "consdatechanged": "2019-08-24T14:15:22Z",
- "consid": 0,
- "consdisplaynote": true,
- "old_consumption": 0.1,
- "pipelineId": 0,
- "conDate": "string"
}
], - "datasource": [
- {
- "datasourceid": "string",
- "datasourcename": "string",
- "datasourcetypeid": "string",
- "pipelineId": 0
}
], - "fundingsource": [
- {
- "fundingsourceid": "string",
- "fundingsourcename": "string",
- "fundingnote": "string",
- "pipelineId": 0
}
], - "inventory": [
- {
- "productid": "string",
- "period": "2019-08-24T14:15:22Z",
- "invamount": 0.1,
- "invtransferflag": true,
- "invnote": "string",
- "invdatechanged": "2019-08-24T14:15:22Z",
- "ctrindex": 0,
- "invdisplaynote": true,
- "invdatasourceid": "string",
- "fimported": true,
- "old_inventory": 0.1,
- "pipelineId": 0,
- "inventoryDate": "string"
}
], - "method": [
- {
- "methodid": "string",
- "methodname": "string",
- "cypfactor": 0.1,
- "methodnote": "string",
- "parentid": 0,
- "categoryid": 0,
- "frollup": true,
- "pipelineId": 0
}
], - "monthlystockarchive": [
- {
- "productid": "string",
- "eoybalance": 0.1,
- "stockyear": 0,
- "stockmonth": 0,
- "pipelineId": 0
}
], - "paste_errors": [
- {
- "f1": "string",
- "f2": "string",
- "f3": 0.1,
- "pipelineId": 0
}
], - "product": [
- {
- "productid": "string",
- "productname": "string",
- "productminmonths": 0,
- "productmaxmonths": 0,
- "supplierid": "string",
- "methodid": "string",
- "productactiveflag": true,
- "productactivedate": "2019-08-24T14:15:22Z",
- "defaultcasesize": 0,
- "productnote": "string",
- "prodcmax": 0,
- "prodcmin": 0,
- "proddesstock": 0,
- "txtinnovatordrugname": "string",
- "dbllowestunitqty": 0.1,
- "txtlowestunitmeasure": "string",
- "txtsubstitutionlist": "string",
- "fpermittedincountry": true,
- "memavailabilitynotes": "string",
- "favailabilitystatus": true,
- "fuserdefined": true,
- "strimportsource": "string",
- "buconversion": 0,
- "txtpreferencenotes": "string",
- "lngamcstart": 0,
- "lngamcmonths": 0,
- "famcchanged": true,
- "txtmigrationstatus": 0,
- "txtmigrationstatusdate": "2019-08-24T14:15:22Z",
- "strtype": "string",
- "oldproductid": "string",
- "oldproductname": "string",
- "lngbatch": 0,
- "oldmethodid": "string",
- "pipelineId": 0
}
], - "productfreightcost": [
- {
- "productid": "string",
- "supplierid": "string",
- "freightcost": 0.1,
- "dtmchanged": "2019-08-24T14:15:22Z",
- "pipelineId": 0
}
], - "productsuppliercasesize": [
- {
- "productid": "string",
- "supplierid": "string",
- "dtmeffective": "2019-08-24T14:15:22Z",
- "intcasesize": 0,
- "dtmchanged": "2019-08-24T14:15:22Z",
- "user": "string",
- "note": "string",
- "pipelineId": 0
}
], - "programinfo": [
- {
- "programname": "string",
- "datadirectory": "string",
- "language": "string",
- "defaultleadtimeplan": 0.1,
- "defaultleadtimeorder": 0.1,
- "defaultleadtimeship": 0.1,
- "defaultshipcost": 0.1,
- "programcontact": "string",
- "telephone": "string",
- "fax": "string",
- "email": "string",
- "countrycode": "string",
- "countryname": "string",
- "iscurrent": true,
- "note": "string",
- "programcode": "string",
- "isactive": true,
- "startsize": "string",
- "isdefault": true,
- "archivedate": "2019-08-24T14:15:22Z",
- "archiveyear": 0,
- "archiveinclude": true,
- "pipelineId": 0
}
], - "shipment": [
- {
- "shipmentid": "string",
- "productid": "string",
- "supplierid": "string",
- "shipdatasourceid": "string",
- "shipamount": 0.1,
- "shipplanneddate": "2019-08-24T14:15:22Z",
- "shipordereddate": "2019-08-24T14:15:22Z",
- "shipshippeddate": "2019-08-24T14:15:22Z",
- "shipreceiveddate": "2019-08-24T14:15:22Z",
- "shipstatuscode": "string",
- "shipnote": "string",
- "shipdatechanged": "2019-08-24T14:15:22Z",
- "shipfreightcost": 0.1,
- "shipvalue": 0.1,
- "shipcaselot": 0,
- "shipdisplaynote": true,
- "shippo": "string",
- "old_shipment": 0.1,
- "shipfundingsourceid": "string",
- "pipelineId": 0
}
], - "source": [
- {
- "supplierid": "string",
- "suppliername": "string",
- "supplierleadtimeplan": 0.1,
- "supplierleadtimeorder": 0.1,
- "supplierleadtimeship": 0.1,
- "suppliernote": "string",
- "freight": 0.1,
- "defaultsupplier": true,
- "pipelineId": 0
}
], - "tblbe_version": [
- {
- "sbe_version": "string",
- "dtmupdated": "2019-08-24T14:15:22Z",
- "pipelineId": 0
}
], - "tblimportproducts": [
- {
- "strproductid": "string",
- "strname": "string",
- "strdose": "string",
- "lngcyp": 0.1,
- "dtmexport": "2019-08-24T14:15:22Z",
- "fprocessed": true,
- "lngid": 0,
- "strsource": "string",
- "strmapping": "string",
- "pipelineId": 0
}
], - "tblimportrecords": [
- {
- "strproductid": "string",
- "dtmperiod": "2019-08-24T14:15:22Z",
- "lngconsumption": 0,
- "lngadjustment": 0,
- "dbldatainterval": 0.1,
- "lngparentid": 0,
- "pipelineId": 0
}
]
}Save Planning Unit For Program
API used to save planning unit for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need planning units to save for |
Request Body schema: application/jsonrequired
Array of planning unit which needs to be saved
| programPlanningUnitId | string |
object (SimpleObject) | |
| planningUnitId | string |
| multiplier | number <double> |
| reorderFrequencyInMonths | integer <int32> |
| minMonthsOfStock | integer <int32> |
| productCategoryId | integer <int32> |
| pipelineProductName | string |
| pipelineProductCategoryName | string |
| localProcurmentLeadTime | number <double> |
| shelfLife | integer <int32> |
| catalogPrice | number <double> |
| monthsInPastForAmc | integer <int32> |
| monthsInFutureForAmc | integer <int32> |
| active | boolean |
Responses
Request samples
- Payload
[- {
- "programPlanningUnitId": "string",
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnitId": "string",
- "multiplier": 0.1,
- "reorderFrequencyInMonths": 0,
- "minMonthsOfStock": 0,
- "productCategoryId": 0,
- "pipelineProductName": "string",
- "pipelineProductCategoryName": "string",
- "localProcurmentLeadTime": 0.1,
- "shelfLife": 0,
- "catalogPrice": 0.1,
- "monthsInPastForAmc": 0,
- "monthsInFutureForAmc": 0,
- "active": true
}
]Save Consumption For Program
API used to save consumption for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need consumption to save for |
Request Body schema: application/jsonrequired
Array of consumption which needs to be saved
| consumptionId | integer <int32> |
| regionId | string |
| planningUnitId | string |
| consumptionDate | string |
| actualFlag | boolean |
| consumptionQty | number <double> |
| dayOfStockOut | integer <int32> |
| dataSourceId | string |
| consNumMonth | integer <int32> |
| notes | string |
| realmCountryPlanningUnitId | integer <int32> |
| multiplier | number <double> |
Responses
Request samples
- Payload
[- {
- "consumptionId": 0,
- "regionId": "string",
- "planningUnitId": "string",
- "consumptionDate": "string",
- "actualFlag": true,
- "consumptionQty": 0.1,
- "dayOfStockOut": 0,
- "dataSourceId": "string",
- "consNumMonth": 0,
- "notes": "string",
- "realmCountryPlanningUnitId": 0,
- "multiplier": 0.1
}
]Save Inventory Data For Program
API used to save inventory for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need inventory to save for |
Request Body schema: application/jsonrequired
Array of inventory which needs to be saved
| planningUnitId | string |
| dataSourceId | string |
| regionId | string |
| inventoryDate | string |
| inventory | integer <int64> |
| manualAdjustment | integer <int64> |
| notes | string |
| active | boolean |
| realmCountryPlanningUnitId | integer <int32> |
| multiplier | number <double> |
Responses
Request samples
- Payload
[- {
- "planningUnitId": "string",
- "dataSourceId": "string",
- "regionId": "string",
- "inventoryDate": "string",
- "inventory": 0,
- "manualAdjustment": 0,
- "notes": "string",
- "active": true,
- "realmCountryPlanningUnitId": 0,
- "multiplier": 0.1
}
]Save QAT Temp Data Source
API used to save data source for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need data source to save for |
Request Body schema: application/jsonrequired
Array of data source which needs to be saved
| dataSourceId | integer <int32> |
| dataSourceTypeId | integer <int32> |
| pipelineDataSourceType | string |
| pipelineDataSource | string |
| pipelineDataSourceId | string |
Responses
Request samples
- Payload
[- {
- "dataSourceId": 0,
- "dataSourceTypeId": 0,
- "pipelineDataSourceType": "string",
- "pipelineDataSource": "string",
- "pipelineDataSourceId": "string"
}
]Save QAT Temp Funding Source
API used to save funding source for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need funding source to save for |
Request Body schema: application/jsonrequired
Array of funding source which needs to be saved
| fundingSourceId | integer <int32> |
| pipelineFundingSource | string |
| pipelineFundingSourceId | string |
Responses
Request samples
- Payload
[- {
- "fundingSourceId": 0,
- "pipelineFundingSource": "string",
- "pipelineFundingSourceId": "string"
}
]Save QAT Temp Procurement Agent
API used to save procurement agent for specified program into temp table
path Parameters
| pipelineId required | integer <int32> PipelineId for which you need procurement agent to save for |
Request Body schema: application/jsonrequired
Array of procurement agent which needs to be saved
| procurementAgentId | integer <int32> |
| pipelineProcurementAgent | string |
| pipelineProcurementAgentId | string |
Responses
Request samples
- Payload
[- {
- "procurementAgentId": 0,
- "pipelineProcurementAgent": "string",
- "pipelineProcurementAgentId": "string"
}
]Update PlanningUnit
API used to update a PlanningUnit
Request Body schema: application/jsonrequired
The PlanningUnit object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| planningUnitId | integer <int32> |
object (ForecastingUnit) | |
object (Label) | |
object (SimpleCodeObject) | |
| multiplier | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "planningUnitId": 0,
- "forecastingUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "multiplier": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add PlanningUnit
API used to add a PlanningUnit
Request Body schema: application/jsonrequired
The PlanningUnit object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| planningUnitId | integer <int32> |
object (ForecastingUnit) | |
object (Label) | |
object (SimpleCodeObject) | |
| multiplier | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "planningUnitId": 0,
- "forecastingUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "multiplier": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get PlanningUnitCapacity list for a PlanningUnitId and a given date range
API used to get PlanningUnitCapacity list for a PlanningUnitId and a given date range
path Parameters
| planningUnitId required | integer <int32> planningUnitId that you want a PlanningUnitCapacity list for |
| startDate required | string startDate the date you want the PlanningUnitCapacity data from |
| stopDate required | string stopDate the date you want the PlanningUnitCapacity data till |
Responses
Update PlanningUnitCapacity
API used to update PlanningUnitCapacity
Request Body schema: application/jsonrequired
planningUnitCapacity objects that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| planningUnitCapacityId | integer <int32> |
object (SimpleObject) | |
object (SimpleObject) | |
| startDate | string |
| stopDate | string |
| capacity | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "planningUnitCapacityId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "supplier": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "startDate": "string",
- "stopDate": "string",
- "capacity": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Get PlanningUnitCapacity for a Realm and a given date range
API used to get PlanningUnitCapacity for a Realm and a given date range
path Parameters
| realmId required | integer <int32> realmId that you want a PlanningUnitCapacity from |
| startDate required | string startDate the date you want the PlanningUnitCapacity data from |
| stopDate required | string stopDate the date you want the PlanningUnitCapacity data till |
Responses
Get active PlanningUnit list for ProductCategory
API used to get the list of active PlanningUnits for a ProductCategory
Request Body schema: application/jsonrequired
array of productCategoryIds that you want the PlanningUnit
Responses
Request samples
- Payload
[- "string"
]The procurement agent PlanningUnits list
API used to get the procurement agent PlanningUnits list
path Parameters
| planningUnitId required | integer <int32> planningUnitId that you want a procurement agent PlanningUnits list for |
| procurementAgentId required | integer <int32> procurementAgentId that you want a procurement agent PlanningUnits list for |
| term required | string term that you want a procurement agent PlanningUnits list for |
Responses
Get active PlanningUnit list for a TracerCategory and a Program
API used to get the list of active PlanningUnits for a tracerCategory and a program
Request Body schema: application/jsonrequired
object containing array of tracerCategory and program that you want the PlanningUnit List for
| tracerCategoryIds | Array of strings |
| programIds | Array of strings |
| programIdsString | string |
| tracerCategoryIdsString | string |
Responses
Request samples
- Payload
{- "tracerCategoryIds": [
- "string"
], - "programIds": [
- "string"
], - "programIdsString": "string",
- "tracerCategoryIdsString": "string"
}Get the list of PlanningUnits for multiple tracerCategoryIds
API used to get the list of PlanningUnits for multiple tracerCategoryIds
Request Body schema: application/jsonrequired
Array of tracerCategoryIds that you want the PlanningUnit List for
Responses
Request samples
- Payload
[- "string"
]Get the list of PlanningUnits for productCategoryId and programId
API used to get the list of PlanningUnits for productCategoryId and programId
path Parameters
| productCategoryId required | integer <int32> productCategoryId that you want a PlanningUnits list for |
| programId required | integer <int32> programId that you want a PlanningUnits list for |
Responses
Get active Problem Report list for a program and version
API used to get the list of active problem report list for a programId and versionId
path Parameters
| programId required | integer <int32> programId that you want the problem report list for |
| versionId required | integer <int32> versionId that you want the problem report list for |
Responses
Add ProcurementAgentType
API used to add a ProcurementAgentType
Request Body schema: application/jsonrequired
The procurementAgentType object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
| procurementAgentTypeCode | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "procurementAgentTypeCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update procurementAgentType
API used to update a procurementAgentType
Request Body schema: application/jsonrequired
The procurementAgentType object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentTypeId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
| procurementAgentTypeCode | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentTypeId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "procurementAgentTypeCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update ProcurementAgent
API used to update a ProcurementAgent
Request Body schema: application/jsonrequired
The ProcurementAgent object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
| procurementAgentCode | string |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| colorHtmlCode | string |
Array of objects (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "procurementAgentType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "procurementAgentCode": "string",
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "colorHtmlCode": "string",
- "programList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add ProcurementAgent
API used to add a ProcurementAgent
Request Body schema: application/jsonrequired
The ProcurementAgent object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
| procurementAgentCode | string |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| colorHtmlCode | string |
Array of objects (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "procurementAgentType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "procurementAgentCode": "string",
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "colorHtmlCode": "string",
- "programList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get ProcurementAgent Planning Unit list for a Procurement Agent
API used to get the ProcurementAgent Planning Unit list for a Procurement Agent. Will only return those PlanningUnits that are marked active.
path Parameters
| procurementAgentId required | integer <int32> ProcurementAgentId that you want to the ProcurementAgent PlanningUnit list for |
Responses
Get ProcurementAgent Procurement Unit list for a Procurement Agent.
API used to get the ProcurementAgent ProcurementUnit list for a Procurement Agent. Will only return those ProcurementUnits that are marked active.
path Parameters
| procurementAgentId required | integer <int32> ProcurementAgentId that you want to the Procurement Unit list for |
Responses
Get ProcurementAgent Planning Unit list for a multiple planningUnitIds
API used to get the ProcurementAgent Planning Unit list for multiple planningUnitIds.
Request Body schema: application/jsonrequired
planningUnitIds that you want to the ProcurementAgent PlanningUnit list for
Responses
Request samples
- Payload
[- 0
]Get ProcurementAgent by display name
API used to get the ProcurementAgent by providing the display name of the ProcurementAgent and the Realm
path Parameters
| realmId required | integer <int32> RealmId that you want to the ProcurementAgent for |
| name required | string Display name that you want to the ProcurementAgent for |
Responses
Update ProcurementAgent PlanningUnits
API used to save the ProcurementAgentPlanningUnits list
Request Body schema: application/jsonrequired
Array of ProcurementAgentPlanningUnits that you want to save
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentPlanningUnitId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleObject) | |
| skuCode | string |
| catalogPrice | number <double> |
| moq | integer <int32> |
| unitsPerPalletEuro1 | integer <int32> |
| unitsPerPalletEuro2 | integer <int32> |
| unitsPerContainer | integer <int32> |
| volume | number <double> |
| weight | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentPlanningUnitId": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "skuCode": "string",
- "catalogPrice": 0.1,
- "moq": 0,
- "unitsPerPalletEuro1": 0,
- "unitsPerPalletEuro2": 0,
- "unitsPerContainer": 0,
- "volume": 0.1,
- "weight": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Update ProcurementAgent ProcurementUnits
API used to save the ProcurementAgentProcurementUnits list
Request Body schema: application/jsonrequired
Array of ProcurementAgentProcurementUnits that you want to save
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementAgentProcurementUnitId | integer <int32> |
object (SimpleObject) | |
object (SimpleObject) | |
| skuCode | string |
| vendorPrice | number <double> |
| approvedToShippedLeadTime | number <double> |
| gtin | string |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementAgentProcurementUnitId": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "procurementUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "skuCode": "string",
- "vendorPrice": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "gtin": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Get Complete ProcurementAgent Procurement Unit list for a Procurement Agent
API used to get the complete ProcurementAgent ProcurementUnit list for a Procurement Agent.
path Parameters
| procurementAgentId required | integer <int32> ProcurementAgentId that you want to the Procurement unit list for |
Responses
Update ProcurementUnit
API used to update a ProcurementUnit
Request Body schema: application/jsonrequired
The ProcurementUnit object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementUnitId | integer <int32> |
object (PlanningUnit) | |
object (Label) | |
object (SimpleObject) | |
| multiplier | number <double> |
object (SimpleObject) | |
| widthQty | number <double> |
| heightQty | number <double> |
| lengthQty | number <double> |
object (SimpleObject) | |
| weightQty | number <double> |
object (SimpleObject) | |
| volumeQty | number <double> |
object (SimpleObject) | |
| unitsPerCase | number <double> |
| unitsPerPalletEuro1 | number <double> |
| unitsPerPalletEuro2 | number <double> |
| unitsPerContainer | number <double> |
| labeling | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementUnitId": 0,
- "planningUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "planningUnitId": 0,
- "forecastingUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "multiplier": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "multiplier": 0.1,
- "supplier": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "widthQty": 0.1,
- "heightQty": 0.1,
- "lengthQty": 0.1,
- "lengthUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "weightQty": 0.1,
- "weightUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "volumeQty": 0.1,
- "volumeUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unitsPerCase": 0.1,
- "unitsPerPalletEuro1": 0.1,
- "unitsPerPalletEuro2": 0.1,
- "unitsPerContainer": 0.1,
- "labeling": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add ProcurementUnit
API used to add a ProcurementUnit
Request Body schema: application/jsonrequired
The ProcurementUnit object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| procurementUnitId | integer <int32> |
object (PlanningUnit) | |
object (Label) | |
object (SimpleObject) | |
| multiplier | number <double> |
object (SimpleObject) | |
| widthQty | number <double> |
| heightQty | number <double> |
| lengthQty | number <double> |
object (SimpleObject) | |
| weightQty | number <double> |
object (SimpleObject) | |
| volumeQty | number <double> |
object (SimpleObject) | |
| unitsPerCase | number <double> |
| unitsPerPalletEuro1 | number <double> |
| unitsPerPalletEuro2 | number <double> |
| unitsPerContainer | number <double> |
| labeling | string |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "procurementUnitId": 0,
- "planningUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "planningUnitId": 0,
- "forecastingUnit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "forecastingUnitId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "genericLabel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "multiplier": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "multiplier": 0.1,
- "supplier": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "widthQty": 0.1,
- "heightQty": 0.1,
- "lengthQty": 0.1,
- "lengthUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "weightQty": 0.1,
- "weightUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "volumeQty": 0.1,
- "volumeUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "unitsPerCase": 0.1,
- "unitsPerPalletEuro1": 0.1,
- "unitsPerPalletEuro2": 0.1,
- "unitsPerContainer": 0.1,
- "labeling": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update ProductCategory tree
API used to update the ProductCategory tree
Request Body schema: application/jsonrequired
The Array of ProductCategories that you want to update
| id | integer <int32> |
| parentId | integer <int32> |
| payload | object |
| level | integer <int32> |
| sortOrder | string |
| payloadId | integer <int32> |
Responses
Request samples
- Payload
[- {
- "id": 0,
- "parentId": 0,
- "payload": { },
- "level": 0,
- "sortOrder": "string",
- "payloadId": 0
}
]Get ProductCategory list for Realm
API used to get the complete ProductCategory list for a Realm
path Parameters
| realmId required | integer <int32> RealmId that you want the ProductCategory list for |
| productCategoryId required | integer <int32> ProductCategoryId that you want the Tree for |
| includeCurrentLevel required | boolean true indicates that you want to include the current node of the tree in the output, false will skip the current level and give all the child nodes |
| includeAllChildren required | boolean true will include all the child nodes in the tree in the response, false will only include the immediate child nodes |
Responses
Get ProductCategory list for Realm and Program
API used to get the complete ProductCategory list for a Realm and Program
path Parameters
| realmId required | integer <int32> RealmId that you want the ProductCategory list for |
| programId required | integer <int32> ProgramId that you want the ProductCategory list for |
Responses
Forecasting Unit import data from Supply Plan
API Used in Forecasting Unit import data from Supply Plan
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitIds | Array of strings |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| regionIds | Array of strings |
| planningUnitIdString | string |
| regionIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "planningUnitIds": [
- "string"
], - "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "regionIds": [
- "string"
], - "planningUnitIdString": "string",
- "regionIdString": "string"
}Get the list of programVersion based on given parameters and date range
API used to get the list of programVersion based on given parameters and date range
path Parameters
| programId required | integer <int32> programId that you want to the programVersion list for |
| versionId required | integer <int32> versionId that you want to the programVersion list for |
| realmCountryId required | integer <int32> realmCountryId that you want to the programVersion list for |
| healthAreaId required | integer <int32> healthAreaId that you want to the programVersion list for |
| organisationId required | integer <int32> organisationId that you want to the programVersion list for |
| versionTypeId required | integer <int32> versionTypeId that you want to the programVersion list for |
| versionStatusId required | integer <int32> versionStatusId that you want to the programVersion list for |
| startDate required | string startDate that you want to the programVersion list from |
| stopDate required | string stopDate that you want to the programVersion list till |
Responses
Update a programVersion for given programId and versionId
API used to update a programVersion for given programId and versionId
path Parameters
| programId required | integer <int32> programId that you want to update programVersion for |
| versionId required | integer <int32> versionId that you want to update programVersion for |
| versionStatusId required | integer <int32> versionStatusId that you want to update in programVersion |
Request Body schema: application/jsonrequired
updateProgramVersion object that you want to update
Array of objects (ReviewedProblem) | |
| notes | string |
Responses
Request samples
- Payload
{- "reviewedProblemList": [
- {
- "problemReportId": 0,
- "reviewed": true,
- "notes": "string",
- "problemStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}
}
], - "notes": "string"
}Get ProgramData list for listed ProgramIds and VersionIds
API used to get ProgramData list for listed ProgramIds and VersionIds
Request Body schema: application/jsonrequired
programVersionList list of ProgramIds and VersionIds that you want a ProgramData list for
| programId | integer <int32> |
| versionId | integer <int32> |
Responses
Request samples
- Payload
[- {
- "programId": 0,
- "versionId": 0
}
]Get Artmis view ProgramData list for given ProgramId and VersionId
API used to get Artmis view ProgramData list for given ProgramId and VersionId
path Parameters
| programId required | integer <int32> programId that you want to the ProgramData for |
| versionId required | integer <int32> versionId that you want to the ProgramData for |
Responses
Get Artmis view ProgramData list for given ProgramId and VersionId
API used to get GfpVan view ProgramData list for given ProgramId and VersionId
path Parameters
| programId required | integer <int32> programId that you want to the ProgramData for |
| versionId required | integer <int32> versionId that you want to the ProgramData for |
Responses
Get list of Shipment data for given programId and versionId which are modified after given date
API used to get list of Shipment data for given programId and versionId which are modified after given date
path Parameters
| programId required | integer <int32> programId that want the Shipment data for |
| versionId required | integer <int32> versionId that want the Shipment data for |
| userId required | integer <int32> userId need this back in response |
| lastSyncDate required | string lastSyncDate that you want a Shipment data list |
Responses
To check if newer version available for list programIds and versionIds
API to check if newer version available for list programIds and versionIds
Request Body schema: application/jsonrequired
programVersionList that you want to check newer version for
| programId | integer <int32> |
| versionId | integer <int32> |
Responses
Request samples
- Payload
[- {
- "programId": 0,
- "versionId": 0
}
]Update Program
API used to update a Program
Request Body schema: application/jsonrequired
Program object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| programTypeId | integer <int32> |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
| healthAreaArray | Array of strings |
| regionArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "programTypeId": 0,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "healthAreaArray": [
- "string"
], - "regionArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Program
API used to add a Program
Request Body schema: application/jsonrequired
Program object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| programTypeId | integer <int32> |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
| healthAreaArray | Array of strings |
| regionArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "programTypeId": 0,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "healthAreaArray": [
- "string"
], - "regionArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}List five versions of program from give page number for specified programId
API used to list five versions of program from given page number for specified programId
path Parameters
| programId required | integer <int32> programId that you want to get program list for |
| page required | integer <int32> number that you want to get program list from |
Responses
Validate Program for specified realmId,programId and programCode
API used to validate Program for specified realmId,programId and programCode
path Parameters
| realmId required | integer <int32> realmId that you want to validate program for |
| programId required | integer <int32> programId that you want to validate program for |
| programCode required | string programCode that you want to validate program for |
Responses
Save a PlanningUnit Unit For Specified Program
API used to save a PlanningUnit Unit for specified programId
Request Body schema: application/jsonrequired
Array of ProgramPlanningUnit object that you want to save
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programPlanningUnitId | integer <int32> |
object (SimpleObject) | |
object (SimpleObject) | |
object (SimpleObject) | |
object (SimpleObject) | |
| multiplier | number <double> |
| reorderFrequencyInMonths | integer <int32> |
| minMonthsOfStock | integer <int32> |
| localProcurementLeadTime | number <double> |
| shelfLife | integer <int32> |
| catalogPrice | number <double> |
| monthsInFutureForAmc | integer <int32> |
| monthsInPastForAmc | integer <int32> |
Array of objects (ProgramPlanningUnitProcurementAgentPrice) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programPlanningUnitId": 0,
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "multiplier": 0.1,
- "reorderFrequencyInMonths": 0,
- "minMonthsOfStock": 0,
- "localProcurementLeadTime": 0.1,
- "shelfLife": 0,
- "catalogPrice": 0.1,
- "monthsInFutureForAmc": 0,
- "monthsInPastForAmc": 0,
- "programPlanningUnitProcurementAgentPrices": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programPlanningUnitProcurementAgentId": 0,
- "programPlanningUnitId": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "price": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Get Planning Unit List For Specified ProgramId and TracerCategoryIds
API used to get the Planning unit list for specified programId and tracerCategoryIds
path Parameters
| programId required | integer <int32> programId that you want to get Planning unit list for |
Request Body schema: application/jsonrequired
Array of tracerCategoryIds that you want to get Planning unit list for
Responses
Request samples
- Payload
[- "string"
]Get simple Planning Unit List For Specified ProgramId and TracerCategoryIds
API used to get simple Planning unit list for specified programId and tracerCategoryIds
path Parameters
| programId required | integer <int32> programId that you want to get simple Planning unit list for |
Request Body schema: application/jsonrequired
Array of tracerCategoryIds that you want to get simple Planning unit list for
Responses
Request samples
- Payload
[- "string"
]Save PlanningUnit Unit, ProcurementAgent and Price
API used to save a PlanningUnit Unit, ProcurementAgent and Price
Request Body schema: application/jsonrequired
Array of programPlanningUnitProcurementAgentPrices object that you want to save
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programPlanningUnitProcurementAgentId | integer <int32> |
| programPlanningUnitId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleObject) | |
object (SimpleObject) | |
| price | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programPlanningUnitProcurementAgentId": 0,
- "programPlanningUnitId": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "price": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]get PlanningUnit List For Specified ProgramIds
API used to get the PlanningUnit list for specified ProgramIds
Request Body schema: application/jsonrequired
Array of programIds that you want to get PlanningUnit list for
Responses
Request samples
- Payload
[- 0
]Get Planning Unit List For Specified ProgramId and ProductCategoryId
API used to get the Planning unit list for specified programId and ProductCategoryId
path Parameters
| programId required | integer <int32> programId that you want to get Planning unit list for |
| productCategoryId required | integer <int32> productCategoryId that you want to get Planning unit list for |
Responses
Add a ProgramInitialize
API used to add a ProgramInitialize
Request Body schema: application/jsonrequired
ProgramInitialize object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| programId | integer <int32> |
| programCode | string |
object (RealmCountry) | |
object (SimpleCodeObject) | |
Array of objects (SimpleCodeObject) | |
object (Label) | |
object (BasicUser) | |
| programNotes | string |
| airFreightPerc | number <double> |
| seaFreightPerc | number <double> |
| plannedToSubmittedLeadTime | number <double> |
| submittedToApprovedLeadTime | number <double> |
| approvedToShippedLeadTime | number <double> |
| shippedToArrivedByAirLeadTime | number <double> |
| shippedToArrivedBySeaLeadTime | number <double> |
| arrivedToDeliveredLeadTime | number <double> |
| programTypeId | integer <int32> |
Array of objects (Region) | |
object (Version) | |
Array of objects (Version) | |
Array of objects (ProgramPlanningUnit) | |
| healthAreaArray | Array of strings |
| regionArray | Array of strings |
| healthAreaIdList | Array of integers <int32> [ items <int32 > ] |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programId": 0,
- "programCode": "string",
- "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisation": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthAreaList": [
- {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
], - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programManager": {
- "userId": 0,
- "username": "string"
}, - "programNotes": "string",
- "airFreightPerc": 0.1,
- "seaFreightPerc": 0.1,
- "plannedToSubmittedLeadTime": 0.1,
- "submittedToApprovedLeadTime": 0.1,
- "approvedToShippedLeadTime": 0.1,
- "shippedToArrivedByAirLeadTime": 0.1,
- "shippedToArrivedBySeaLeadTime": 0.1,
- "arrivedToDeliveredLeadTime": 0.1,
- "programTypeId": 0,
- "regionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "currentVersion": {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}, - "versionList": [
- {
- "versionId": 0,
- "versionType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "versionStatus": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "notes": "string",
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedDate": "2019-08-24T14:15:22Z",
- "forecastStartDate": "2019-08-24T14:15:22Z",
- "forecastStopDate": "2019-08-24T14:15:22Z",
- "daysInMonth": 0,
- "freightPerc": 0.1,
- "forecastThresholdHighPerc": 0.1,
- "forecastThresholdLowPerc": 0.1
}
], - "programPlanningUnits": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programPlanningUnitId": 0,
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "productCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "multiplier": 0.1,
- "reorderFrequencyInMonths": 0,
- "minMonthsOfStock": 0,
- "localProcurementLeadTime": 0.1,
- "shelfLife": 0,
- "catalogPrice": 0.1,
- "monthsInFutureForAmc": 0,
- "monthsInPastForAmc": 0,
- "programPlanningUnitProcurementAgentPrices": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "programPlanningUnitProcurementAgentId": 0,
- "programPlanningUnitId": 0,
- "procurementAgent": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "price": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "healthAreaArray": [
- "string"
], - "regionArray": [
- "string"
], - "healthAreaIdList": [
- 0
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Format forecast data to import
API used to format forecast data to import in a specified program
path Parameters
| programId required | string ProgramId that you want to format forecast data to import for |
Request Body schema: application/json
File containing forecast data to format for import
| file | string <binary> |
Responses
Request samples
- Payload
{- "file": "string"
}Update RealmCountry
API used to update a RealmCountry
Request Body schema: application/jsonrequired
List of RealmCountry that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| realmCountryId | integer <int32> |
object (Country) | |
object (Realm) | |
object (Currency) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Add RealmCountry
API used to add a RealmCountry
Request Body schema: application/jsonrequired
List of RealmCountry that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| realmCountryId | integer <int32> |
object (Country) | |
object (Realm) | |
object (Currency) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Save PlanningUnit for RealmCountry
API used to save PlanningUnit for RealmCountry
Request Body schema: application/jsonrequired
Array of realmCountryPlanningUnits that you want to save
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| realmCountryPlanningUnitId | integer <int32> |
object (SimpleObject) | |
object (SimpleObject) | |
| skuCode | string |
object (Label) | |
| multiplier | number <double> |
object (Unit) | |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryPlanningUnitId": 0,
- "realmCountry": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "skuCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "multiplier": 0.1,
- "unit": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "unitId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unitCode": "string",
- "dimension": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Get RealmCountryPlanningUnit list for a specific programIds
API used to get RealmCountryPlanningUnit list for a specific programIds
Request Body schema: application/jsonrequired
Array of programIds that you want RealmCountryPlanningUnit list for
Responses
Request samples
- Payload
[- "string"
]Update Realm
API used to update a Realm
Request Body schema: application/jsonrequired
The Realm object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| realmId | integer <int32> |
object (Label) | |
| realmCode | string |
| defaultRealm | boolean |
| minMosMinGaurdrail | integer <int32> |
| minMosMaxGaurdrail | integer <int32> |
| maxMosMaxGaurdrail | integer <int32> |
| minQplTolerance | integer <int32> |
| minQplToleranceCutOff | integer <int32> |
| maxQplTolerance | integer <int32> |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Realm
API used to add a Realm
Request Body schema: application/jsonrequired
The Realm object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| realmId | integer <int32> |
object (Label) | |
| realmCode | string |
| defaultRealm | boolean |
| minMosMinGaurdrail | integer <int32> |
| minMosMaxGaurdrail | integer <int32> |
| maxMosMaxGaurdrail | integer <int32> |
| minQplTolerance | integer <int32> |
| minQplToleranceCutOff | integer <int32> |
| maxQplTolerance | integer <int32> |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update Region
API used to update a Region
Request Body schema: application/jsonrequired
The array of Regions that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| regionId | integer <int32> |
object (Label) | |
object (RealmCountry) | |
| gln | string |
| capacityCbm | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "regionId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCountry": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmCountryId": 0,
- "country": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "countryId": 0,
- "countryCode": "string",
- "countryCode2": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "currency": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultCurrency": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "currencyId": 0,
- "currencyCode": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "conversionRateToUsd": 0.1,
- "isSync": true,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "gln": "string",
- "capacityCbm": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]get the ExpiredStockOutput list
API used to get the ExpiredStockOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| includePlannedShipments | boolean |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "includePlannedShipments": true
}get the CostOfInventoryOutput list
API used to get the CostOfInventoryOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| dt | string <date-time> |
| includePlannedShipments | boolean |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "dt": "2019-08-24T14:15:22Z",
- "includePlannedShipments": true
}get the InventoryTurnsOutput list
API used to get the InventoryTurnsOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| dt | string <date-time> |
| includePlannedShipments | boolean |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "dt": "2019-08-24T14:15:22Z",
- "includePlannedShipments": true
}get the StockAdjustmentReportOutput list
API used to get the StockAdjustmentReportOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| planningUnitIds | Array of strings |
| startDateString | string |
| stopDateString | string |
| planningUnitIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "planningUnitIds": [
- "string"
], - "startDateString": "string",
- "stopDateString": "string",
- "planningUnitIdString": "string"
}get the ProcurementAgentShipmentReportOutput list
API used to get the ProcurementAgentShipmentReportOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitIds | Array of strings |
| includePlannedShipments | boolean |
| procurementAgentIds | Array of strings |
| procurementAgentIdString | string |
| planningUnitIdString | string |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "planningUnitIds": [
- "string"
], - "includePlannedShipments": true,
- "procurementAgentIds": [
- "string"
], - "procurementAgentIdString": "string",
- "planningUnitIdString": "string"
}get the ProgramLeadTimesOutput list
API used to get the ProgramLeadTimesOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| planningUnitIds | Array of strings |
| procurementAgentIds | Array of strings |
| planningUnitIdString | string |
| procurementAgentIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "planningUnitIds": [
- "string"
], - "procurementAgentIds": [
- "string"
], - "planningUnitIdString": "string",
- "procurementAgentIdString": "string"
}get the FundingSourceShipmentReportOutput list
API used to get the FundingSourceShipmentReportOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitIds | Array of strings |
| includePlannedShipments | boolean |
| fundingSourceIds | Array of strings |
| fundingSourceIdString | string |
| planningUnitIdString | string |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "planningUnitIds": [
- "string"
], - "includePlannedShipments": true,
- "fundingSourceIds": [
- "string"
], - "fundingSourceIdString": "string",
- "planningUnitIdString": "string"
}get the StockStatusVerticalOutput list
API used to get the StockStatusVerticalOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| planningUnitId | integer <int32> |
| allPlanningUnits | boolean |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "planningUnitId": 0,
- "allPlanningUnits": true
}get the StockStatusOverTimeOutput list
API used to get the StockStatusOverTimeOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| mosPast | integer <int32> |
| mosFuture | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| planningUnitIds | Array of strings |
| planningUnitIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "mosPast": 0,
- "mosFuture": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "planningUnitIds": [
- "string"
], - "planningUnitIdString": "string"
}get the ProgramProductCatalogOutput list
API used to get the ProgramProductCatalogOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| productCategoryId | integer <int32> |
| tracerCategoryId | integer <int32> |
Responses
Request samples
- Payload
{- "programId": 0,
- "productCategoryId": 0,
- "tracerCategoryId": 0
}get the ConsumptionForecastVsActualOutput list
API used to get the ConsumptionForecastVsActualOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitId | integer <int32> |
| reportView | integer <int32> |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "planningUnitId": 0,
- "reportView": 0
}get the GlobalConsumptionOutput list
API used to get the GlobalConsumptionOutput list.
Request Body schema: application/jsonrequired
| realmId | integer <int32> |
| realmCountryIds | Array of strings |
| programIds | Array of strings |
| planningUnitIds | Array of strings |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| reportView | integer <int32> |
| useApprovedSupplyPlanOnly | boolean |
| planningUnitIdString | string |
| programIdString | string |
| realmCountryIdString | string |
Responses
Request samples
- Payload
{- "realmId": 0,
- "realmCountryIds": [
- "string"
], - "programIds": [
- "string"
], - "planningUnitIds": [
- "string"
], - "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "reportView": 0,
- "useApprovedSupplyPlanOnly": true,
- "planningUnitIdString": "string",
- "programIdString": "string",
- "realmCountryIdString": "string"
}get the ForecastMetricsMonthlyOutput list
API used to get the ForecastMetricsMonthlyOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitId | integer <int32> |
| previousMonths | integer <int32> |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "planningUnitId": 0,
- "previousMonths": 0
}get the ForecastMetricsComparisionOutput list
API used to get the ForecastMetricsComparisionOutput list.
Request Body schema: application/jsonrequired
| realmId | integer <int32> |
| realmCountryIds | Array of strings |
| programIds | Array of strings |
| planningUnitIds | Array of strings |
| tracerCategoryIds | Array of strings |
| startDate | string <date-time> |
| previousMonths | integer <int32> |
| useApprovedSupplyPlanOnly | boolean |
Responses
Request samples
- Payload
{- "realmId": 0,
- "realmCountryIds": [
- "string"
], - "programIds": [
- "string"
], - "planningUnitIds": [
- "string"
], - "tracerCategoryIds": [
- "string"
], - "startDate": "2019-08-24T14:15:22Z",
- "previousMonths": 0,
- "useApprovedSupplyPlanOnly": true
}get the StockStatusMatrixOutput list
API used to get the StockStatusMatrixOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| planningUnitIds | Array of strings |
| tracerCategoryIds | Array of strings |
| includePlannedShipments | boolean |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "planningUnitIds": [
- "string"
], - "tracerCategoryIds": [
- "string"
], - "includePlannedShipments": true
}get the ShipmentDetailsOutput object
API used to get the ShipmentDetailsOutput object.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| fundingSourceIds | Array of strings |
| budgetIds | Array of strings |
| planningUnitIds | Array of strings |
| reportView | integer <int32> |
| planningUnitIdsString | string |
| fundingSourceIdsString | string |
| budgetIdsString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "fundingSourceIds": [
- "string"
], - "budgetIds": [
- "string"
], - "planningUnitIds": [
- "string"
], - "reportView": 0,
- "planningUnitIdsString": "string",
- "fundingSourceIdsString": "string",
- "budgetIdsString": "string"
}get the ShipmentOverviewOutput object
API used to get the ShipmentOverviewOutput object.
Request Body schema: application/jsonrequired
| realmId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| realmCountryIds | Array of strings |
| programIds | Array of strings |
| planningUnitIds | Array of strings |
| fundingSourceIds | Array of strings |
| shipmentStatusIds | Array of strings |
| useApprovedSupplyPlanOnly | boolean |
| programIdsString | string |
| planningUnitIdsString | string |
| fundingSourceIdsString | string |
| realmCountryIdsString | string |
| shipmentStatusIdsString | string |
Responses
Request samples
- Payload
{- "realmId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "realmCountryIds": [
- "string"
], - "programIds": [
- "string"
], - "planningUnitIds": [
- "string"
], - "fundingSourceIds": [
- "string"
], - "shipmentStatusIds": [
- "string"
], - "useApprovedSupplyPlanOnly": true,
- "programIdsString": "string",
- "planningUnitIdsString": "string",
- "fundingSourceIdsString": "string",
- "realmCountryIdsString": "string",
- "shipmentStatusIdsString": "string"
}get the ShipmentGlobalDemandOutput object
API used to get the ShipmentGlobalDemandOutput object.
Request Body schema: application/jsonrequired
| realmId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| realmCountryIds | Array of strings |
| planningUnitId | integer <int32> |
| reportView | integer <int32> |
| fundingSourceProcurementAgentIds | Array of strings |
| useApprovedSupplyPlanOnly | boolean |
| includePlannedShipments | boolean |
| realmCountryIdsString | string |
| fundingSourceProcurementAgentIdsString | string |
Responses
Request samples
- Payload
{- "realmId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "realmCountryIds": [
- "string"
], - "planningUnitId": 0,
- "reportView": 0,
- "fundingSourceProcurementAgentIds": [
- "string"
], - "useApprovedSupplyPlanOnly": true,
- "includePlannedShipments": true,
- "realmCountryIdsString": "string",
- "fundingSourceProcurementAgentIdsString": "string"
}get the AnnualShipmentCostOutput list
API used to get the AnnualShipmentCostOutput list.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitIds | Array of strings |
| procurementAgentIds | Array of strings |
| fundingSourceIds | Array of strings |
| shipmentStatusIds | Array of strings |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| reportBasedOn | integer <int32> |
| planningUnitIdString | string |
| procurementAgentIdString | string |
| fundingSourceIdString | string |
| shipmentStatusIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "planningUnitIds": [
- "string"
], - "procurementAgentIds": [
- "string"
], - "fundingSourceIds": [
- "string"
], - "shipmentStatusIds": [
- "string"
], - "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "reportBasedOn": 0,
- "planningUnitIdString": "string",
- "procurementAgentIdString": "string",
- "fundingSourceIdString": "string",
- "shipmentStatusIdString": "string"
}get the ShipmentReportOutput list
API used to get the ShipmentReportOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| planningUnitIds | Array of strings |
| includePlannedShipments | boolean |
| planningUnitIdString | string |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "planningUnitIds": [
- "string"
], - "includePlannedShipments": true,
- "planningUnitIdString": "string"
}get the StockStatusForProgramOutput list
API used to get the StockStatusForProgramOutput list.
Request Body schema: application/jsonrequired
| dt | string <date-time> |
| programId | integer <int32> |
| versionId | integer <int32> |
| tracerCategoryIds | Array of strings |
| includePlannedShipments | boolean |
| tracerCategoryIdString | string |
Responses
Request samples
- Payload
{- "dt": "2019-08-24T14:15:22Z",
- "programId": 0,
- "versionId": 0,
- "tracerCategoryIds": [
- "string"
], - "includePlannedShipments": true,
- "tracerCategoryIdString": "string"
}get the BudgetReportOutput list
API used to get the BudgetReportOutput list.
Request Body schema: application/jsonrequired
| startDate | string <date-time> |
| stopDate | string <date-time> |
| fundingSourceIds | Array of strings |
| programId | integer <int32> |
| versionId | integer <int32> |
| fundingSourceIdString | string |
Responses
Request samples
- Payload
{- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "fundingSourceIds": [
- "string"
], - "programId": 0,
- "versionId": 0,
- "fundingSourceIdString": "string"
}Get Forecast error report
API used to get the forecast error report.
Request Body schema: application/jsonrequired
| programId | integer <int32> |
| versionId | integer <int32> |
| viewBy | integer <int32> |
| unitId | integer <int32> |
| regionIds | Array of strings |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| equivalencyUnitId | integer <int32> |
| regionIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "viewBy": 0,
- "unitId": 0,
- "regionIds": [
- "string"
], - "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "equivalencyUnitId": 0,
- "regionIdString": "string"
}Get MOnthly Forecast report
API used to get the monthly forecast report.
Request Body schema: application/jsonrequired
MonthlyForecastInput object that you want to monthly forecast report for
| programId | integer <int32> |
| versionId | integer <int32> |
| startDate | string <date-time> |
| stopDate | string <date-time> |
| reportView | integer <int32> |
| aggregateByYear | boolean |
| unitIds | Array of strings |
| unitIdString | string |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "stopDate": "2019-08-24T14:15:22Z",
- "reportView": 0,
- "aggregateByYear": true,
- "unitIds": [
- "string"
], - "unitIdString": "string"
}Get Forecast summary report
API used to get the forecast summary report.
Request Body schema: application/jsonrequired
ForecastSummaryInput object that you want to forecast summary report for
| programId | integer <int32> |
| versionId | integer <int32> |
| reportView | integer <int32> |
Responses
Request samples
- Payload
{- "programId": 0,
- "versionId": 0,
- "reportView": 0
}get the WarehouseCapacityOutput list
API used to get the WarehouseCapacityOutput list.
Request Body schema: application/jsonrequired
| realmCountryIds | Array of strings |
| programIds | Array of strings |
| programIdString | string |
| realmCountryIdString | string |
Responses
Request samples
- Payload
{- "realmCountryIds": [
- "string"
], - "programIds": [
- "string"
], - "programIdString": "string",
- "realmCountryIdString": "string"
}get the WarehouseByCountryOutput list
API used to get the WarehouseByCountryOutput list.
Request Body schema: application/jsonrequired
| realmCountryIds | Array of strings |
| realmCountryIdString | string |
Responses
Request samples
- Payload
{- "realmCountryIds": [
- "string"
], - "realmCountryIdString": "string"
}get the StockStatusAcrossProductsOutput list
API used to get the StockStatusAcrossProductsOutput list.
Request Body schema: application/jsonrequired
| realmId | integer <int32> |
| dt | string <date-time> |
| tracerCategoryIds | Array of strings |
| realmCountryIds | Array of strings |
| programIds | Array of strings |
| useApprovedSupplyPlanOnly | boolean |
| programIdsString | string |
| tracerCategoryIdsString | string |
| realmCountryIdsString | string |
Responses
Request samples
- Payload
{- "realmId": 0,
- "dt": "2019-08-24T14:15:22Z",
- "tracerCategoryIds": [
- "string"
], - "realmCountryIds": [
- "string"
], - "programIds": [
- "string"
], - "useApprovedSupplyPlanOnly": true,
- "programIdsString": "string",
- "tracerCategoryIdsString": "string",
- "realmCountryIdsString": "string"
}Update Supplier
API used to update a Supplier
Request Body schema: application/jsonrequired
The Supplier object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| supplierId | integer <int32> |
object (Label) | |
object (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "supplierId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Supplier
API used to add a Supplier
Request Body schema: application/jsonrequired
The Supplier object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| supplierId | integer <int32> |
object (Label) | |
object (SimpleCodeObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "supplierId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}To rebuild supply plan based on rebuild true or false
API is to rebuild supply plan based on rebuild true or false
path Parameters
| programId required | integer <int32> programId that you want to rebuild supply plan for |
| versionId required | integer <int32> versionId that you want to rebuild supply plan for |
| rebuild required | boolean rebuild true for rebuild supply plan , rebuild false for do not rebuild supply plan |
Responses
To rebuild supply plan for listed programIds and versionIds
API is to rebuild supply plan for listed programIds and versionIds
Request Body schema: application/jsonrequired
pvList list of programIds and versionIds to rebuild supply plan for
| programId | integer <int32> |
| versionId | integer <int32> |
Responses
Request samples
- Payload
[- {
- "programId": 0,
- "versionId": 0
}
]Update User
API used to update a user
Request Body schema: application/jsonrequired
user object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| userId | integer <int32> |
| username | string |
| password | string |
| emailId | string |
| orgAndCountry | string |
object (Realm) | |
Array of objects (Role) | |
| roles | Array of strings |
object (Language) | |
| defaultModuleId | integer <int32> |
| faildAttempts | integer <int32> |
| lastLoginDate | string <date-time> |
Array of objects (UserAcl) | |
Array of objects (UserAcl) | |
| businessFunctionList | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "userId": 0,
- "username": "string",
- "password": "string",
- "emailId": "string",
- "orgAndCountry": "string",
- "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "roleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "businessFunctionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "businessFunctionId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "businessFunctions": [
- "string"
], - "canCreateRoleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
}
], - "canCreateRoles": [
- "string"
]
}
], - "roles": [
- "string"
], - "language": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "languageId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "languageCode": "string",
- "countryCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultModuleId": 0,
- "faildAttempts": 0,
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "userAclList": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "userAcls": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "businessFunctionList": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add User
API used to add a user
Request Body schema: application/jsonrequired
user object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| userId | integer <int32> |
| username | string |
| password | string |
| emailId | string |
| orgAndCountry | string |
object (Realm) | |
Array of objects (Role) | |
| roles | Array of strings |
object (Language) | |
| defaultModuleId | integer <int32> |
| faildAttempts | integer <int32> |
| lastLoginDate | string <date-time> |
Array of objects (UserAcl) | |
Array of objects (UserAcl) | |
| businessFunctionList | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "userId": 0,
- "username": "string",
- "password": "string",
- "emailId": "string",
- "orgAndCountry": "string",
- "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "roleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "businessFunctionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "businessFunctionId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "businessFunctions": [
- "string"
], - "canCreateRoleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
}
], - "canCreateRoles": [
- "string"
]
}
], - "roles": [
- "string"
], - "language": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "languageId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "languageCode": "string",
- "countryCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultModuleId": 0,
- "faildAttempts": 0,
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "userAclList": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "userAcls": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "businessFunctionList": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update password
API used to update password
Request Body schema: application/jsonrequired
EmailUser object for which password has to update
| userId | integer <int32> |
| username | string |
| emailId | string |
| token | string |
| password | string |
| hashPassword | string |
Responses
Request samples
- Payload
{- "userId": 0,
- "username": "string",
- "emailId": "string",
- "token": "string",
- "password": "string",
- "hashPassword": "string"
}Update Role
API used to update a Role
Request Body schema: application/jsonrequired
role object that you want to update
| roleId | string |
object (Label) | |
Array of objects (BusinessFunction) | |
| businessFunctions | Array of strings |
Array of objects (CanCreateRole) | |
| canCreateRoles | Array of strings |
Responses
Request samples
- Payload
{- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "businessFunctionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "businessFunctionId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "businessFunctions": [
- "string"
], - "canCreateRoleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
}
], - "canCreateRoles": [
- "string"
]
}Add Role
API used to add a Role
Request Body schema: application/jsonrequired
role object that you want to add
| roleId | string |
object (Label) | |
Array of objects (BusinessFunction) | |
| businessFunctions | Array of strings |
Array of objects (CanCreateRole) | |
| canCreateRoles | Array of strings |
Responses
Request samples
- Payload
{- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "businessFunctionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "businessFunctionId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "businessFunctions": [
- "string"
], - "canCreateRoleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
}
], - "canCreateRoles": [
- "string"
]
}Update Expired Password
API used to update expired password
Request Body schema: application/jsonrequired
password object that you want to update
| userId | integer <int32> |
| emailId | string |
| oldPassword | string |
| newPassword | string |
Responses
Request samples
- Payload
{- "userId": 0,
- "emailId": "string",
- "oldPassword": "string",
- "newPassword": "string"
}Change password
API used to update changed password
Request Body schema: application/jsonrequired
password object that you want to change
| userId | integer <int32> |
| emailId | string |
| oldPassword | string |
| newPassword | string |
Responses
Request samples
- Payload
{- "userId": 0,
- "emailId": "string",
- "oldPassword": "string",
- "newPassword": "string"
}Reset forgot password
API used to reset forgot password
Request Body schema: application/jsonrequired
EmailUser object for which password has to reset
| userId | integer <int32> |
| username | string |
| emailId | string |
| token | string |
| password | string |
| hashPassword | string |
Responses
Request samples
- Payload
{- "userId": 0,
- "username": "string",
- "emailId": "string",
- "token": "string",
- "password": "string",
- "hashPassword": "string"
}Confirm Forgot Password
API used to confirm if forgot password token is valid
Request Body schema: application/jsonrequired
EmailUser object for which token has to validate
| userId | integer <int32> |
| username | string |
| emailId | string |
| token | string |
| password | string |
| hashPassword | string |
Responses
Request samples
- Payload
{- "userId": 0,
- "username": "string",
- "emailId": "string",
- "token": "string",
- "password": "string",
- "hashPassword": "string"
}Map Access Control to User
API used to map access controls like realmCountry, organisation, healthArea and program with specified user
Request Body schema: application/jsonrequired
user object for which access control need to map with
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| userId | integer <int32> |
| username | string |
| password | string |
| emailId | string |
| orgAndCountry | string |
object (Realm) | |
Array of objects (Role) | |
| roles | Array of strings |
object (Language) | |
| defaultModuleId | integer <int32> |
| faildAttempts | integer <int32> |
| lastLoginDate | string <date-time> |
Array of objects (UserAcl) | |
Array of objects (UserAcl) | |
| businessFunctionList | Array of strings |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "userId": 0,
- "username": "string",
- "password": "string",
- "emailId": "string",
- "orgAndCountry": "string",
- "realm": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "realmId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmCode": "string",
- "defaultRealm": true,
- "minMosMinGaurdrail": 0,
- "minMosMaxGaurdrail": 0,
- "maxMosMaxGaurdrail": 0,
- "minQplTolerance": 0,
- "minQplToleranceCutOff": 0,
- "maxQplTolerance": 0,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "roleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "businessFunctionList": [
- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "businessFunctionId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
], - "businessFunctions": [
- "string"
], - "canCreateRoleList": [
- {
- "roleId": "string",
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
}
], - "canCreateRoles": [
- "string"
]
}
], - "roles": [
- "string"
], - "language": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "languageId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "languageCode": "string",
- "countryCode": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "defaultModuleId": 0,
- "faildAttempts": 0,
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "userAclList": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "userAcls": [
- {
- "userId": 0,
- "realmCountryId": 0,
- "countryName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "healthAreaId": 0,
- "healthAreaName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "organisationId": 0,
- "organisationName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "programId": 0,
- "programName": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "lastModifiedDate": "string"
}
], - "businessFunctionList": [
- "string"
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update TracerCategory
API used to update a TracerCategory
Request Body schema: application/jsonrequired
The TracerCategory object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| tracerCategoryId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "tracerCategoryId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthArea": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add TracerCategory
API used to add a TracerCategory
Request Body schema: application/jsonrequired
The TracerCategory object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| tracerCategoryId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleCodeObject) | |
object (Label) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "tracerCategoryId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "healthArea": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Get TracerCategory list for Realm and Program
API used to get the complete TracerCategory list for a Realm and Program
path Parameters
| realmId required | integer <int32> RealmId that you want the TracerCategory list for |
| programId required | integer <int32> ProgramId that you want the TracerCategory list for |
Responses
Get TracerCategory list for Realm and active ProgramPlanningUnits
API used to get the TracerCategory list for a Realm. Only returns those Tracer Categories that are from Planning Units in active Programs
path Parameters
| realmId required | integer <int32> RealmId that you want the TracerCategory list for |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
[- "string"
]Update TreeTemplate
API used to update a TreeTemplate
Request Body schema: application/jsonrequired
The treeTemplate object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| treeTemplateId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (SimpleObjectWithType) | |
| monthsInPast | integer <int32> |
| monthsInFuture | integer <int32> |
| notes | string |
Array of objects (TreeLevel) | |
Array of objects (ForecastNodeTreeNode) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "treeTemplateId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastMethod": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "typeId": 0,
- "idString": "string"
}, - "monthsInPast": 0,
- "monthsInFuture": 0,
- "notes": "string",
- "levelList": [
- {
- "levelId": 0,
- "levelNo": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
}
], - "flatList": [
- {
- "id": 0,
- "parent": 0,
- "payload": {
- "nodeId": 0,
- "parentNodeId": 0,
- "nodeType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "modelingAllowed": true,
- "extrapolationAllowed": true,
- "treeTemplateAllowed": true,
- "forecastTreeAllowed": true
}, - "nodeUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "nodeDataMap": {
- "property1": [
- {
- "nodeDataId": 0,
- "month": "string",
- "monthNo": 0,
- "dataValue": 0.1,
- "calculatedDataValue": 0.1,
- "fuNode": {
- "nodeDataFuId": 0,
- "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "tracerCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "productCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "idString": "string"
}, - "lagInMonths": 0,
- "usageType": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "noOfPersons": 0,
- "noOfForecastingUnitsPerPerson": 0,
- "oneTimeUsage": true,
- "usageFrequency": 0.1,
- "usagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}, - "repeatCount": 0.1,
- "repeatUsagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
}, - "puNode": {
- "nodeDataPuId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "multiplier": 0.1,
- "idString": "string"
}, - "sharePlanningUnit": true,
- "refillMonths": 0,
- "puPerVisit": 0
}, - "extrapolation": true,
- "notes": "string",
- "manualChangesEffectFuture": true,
- "nodeDataModelingList": [
- {
- "nodeDataModelingId": 0,
- "startDate": "string",
- "startDateNo": 0,
- "stopDate": "string",
- "stopDateNo": 0,
- "modelingType": {
- "id": null,
- "label": null,
- "idString": null
}, - "dataValue": 0.1,
- "increaseDecrease": 0,
- "transferNodeDataId": 0,
- "notes": "string"
}
], - "nodeDataOverrideList": [
- {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "nodeDataOverrideId": 0,
- "month": "2019-08-24T14:15:22Z",
- "monthNo": 0,
- "manualChange": 0.1,
- "seasonalityPerc": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
], - "nodeDataMomList": [
- {
- "nodeDataMomId": 0,
- "month": "string",
- "startValue": 0.1,
- "endValue": 0.1,
- "calculatedValue": 0.1,
- "calculatedMmdValue": 0.1,
- "difference": 0.1,
- "seasonalityPerc": 0.1,
- "manualChange": 0.1
}
], - "nodeDataExtrapolation": {
- "nodeDataExtapolationId": 0,
- "extrapolationMethod": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "notes": "string",
- "extrapolationDataList": [
- {
- "month": null,
- "amount": null,
- "ci": null,
- "reportingRate": null,
- "manualChange": null
}
]
}, - "nodeDataExtrapolationOptionList": [
- {
- "nodeDataExtapolationOptionId": 0,
- "extrapolationMethod": {
- "id": null,
- "label": null,
- "idString": null
}, - "jsonProperties": {
- "property1": { },
- "property2": { }
}, - "extrapolationOptionDataList": [
- null
], - "jsonPropertiesString": "string"
}
]
}
], - "property2": [
- {
- "nodeDataId": 0,
- "month": "string",
- "monthNo": 0,
- "dataValue": 0.1,
- "calculatedDataValue": 0.1,
- "fuNode": {
- "nodeDataFuId": 0,
- "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "tracerCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "productCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "idString": "string"
}, - "lagInMonths": 0,
- "usageType": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "noOfPersons": 0,
- "noOfForecastingUnitsPerPerson": 0,
- "oneTimeUsage": true,
- "usageFrequency": 0.1,
- "usagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}, - "repeatCount": 0.1,
- "repeatUsagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
}, - "puNode": {
- "nodeDataPuId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "multiplier": 0.1,
- "idString": "string"
}, - "sharePlanningUnit": true,
- "refillMonths": 0,
- "puPerVisit": 0
}, - "extrapolation": true,
- "notes": "string",
- "manualChangesEffectFuture": true,
- "nodeDataModelingList": [
- {
- "nodeDataModelingId": 0,
- "startDate": "string",
- "startDateNo": 0,
- "stopDate": "string",
- "stopDateNo": 0,
- "modelingType": {
- "id": null,
- "label": null,
- "idString": null
}, - "dataValue": 0.1,
- "increaseDecrease": 0,
- "transferNodeDataId": 0,
- "notes": "string"
}
], - "nodeDataOverrideList": [
- {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "nodeDataOverrideId": 0,
- "month": "2019-08-24T14:15:22Z",
- "monthNo": 0,
- "manualChange": 0.1,
- "seasonalityPerc": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
], - "nodeDataMomList": [
- {
- "nodeDataMomId": 0,
- "month": "string",
- "startValue": 0.1,
- "endValue": 0.1,
- "calculatedValue": 0.1,
- "calculatedMmdValue": 0.1,
- "difference": 0.1,
- "seasonalityPerc": 0.1,
- "manualChange": 0.1
}
], - "nodeDataExtrapolation": {
- "nodeDataExtapolationId": 0,
- "extrapolationMethod": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "notes": "string",
- "extrapolationDataList": [
- {
- "month": null,
- "amount": null,
- "ci": null,
- "reportingRate": null,
- "manualChange": null
}
]
}, - "nodeDataExtrapolationOptionList": [
- {
- "nodeDataExtapolationOptionId": 0,
- "extrapolationMethod": {
- "id": null,
- "label": null,
- "idString": null
}, - "jsonProperties": {
- "property1": { },
- "property2": { }
}, - "extrapolationOptionDataList": [
- null
], - "jsonPropertiesString": "string"
}
]
}
]
}
}, - "level": 0,
- "sortOrder": "string",
- "payloadId": 0
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add TreeTemplate
API used to add a TreeTemplate
Request Body schema: application/jsonrequired
The TreeTemplate object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| treeTemplateId | integer <int32> |
object (SimpleCodeObject) | |
object (Label) | |
object (SimpleObjectWithType) | |
| monthsInPast | integer <int32> |
| monthsInFuture | integer <int32> |
| notes | string |
Array of objects (TreeLevel) | |
Array of objects (ForecastNodeTreeNode) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "treeTemplateId": 0,
- "realm": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "forecastMethod": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "typeId": 0,
- "idString": "string"
}, - "monthsInPast": 0,
- "monthsInFuture": 0,
- "notes": "string",
- "levelList": [
- {
- "levelId": 0,
- "levelNo": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}
}
], - "flatList": [
- {
- "id": 0,
- "parent": 0,
- "payload": {
- "nodeId": 0,
- "parentNodeId": 0,
- "nodeType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "modelingAllowed": true,
- "extrapolationAllowed": true,
- "treeTemplateAllowed": true,
- "forecastTreeAllowed": true
}, - "nodeUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "nodeDataMap": {
- "property1": [
- {
- "nodeDataId": 0,
- "month": "string",
- "monthNo": 0,
- "dataValue": 0.1,
- "calculatedDataValue": 0.1,
- "fuNode": {
- "nodeDataFuId": 0,
- "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "tracerCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "productCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "idString": "string"
}, - "lagInMonths": 0,
- "usageType": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "noOfPersons": 0,
- "noOfForecastingUnitsPerPerson": 0,
- "oneTimeUsage": true,
- "usageFrequency": 0.1,
- "usagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}, - "repeatCount": 0.1,
- "repeatUsagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
}, - "puNode": {
- "nodeDataPuId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "multiplier": 0.1,
- "idString": "string"
}, - "sharePlanningUnit": true,
- "refillMonths": 0,
- "puPerVisit": 0
}, - "extrapolation": true,
- "notes": "string",
- "manualChangesEffectFuture": true,
- "nodeDataModelingList": [
- {
- "nodeDataModelingId": 0,
- "startDate": "string",
- "startDateNo": 0,
- "stopDate": "string",
- "stopDateNo": 0,
- "modelingType": {
- "id": null,
- "label": null,
- "idString": null
}, - "dataValue": 0.1,
- "increaseDecrease": 0,
- "transferNodeDataId": 0,
- "notes": "string"
}
], - "nodeDataOverrideList": [
- {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "nodeDataOverrideId": 0,
- "month": "2019-08-24T14:15:22Z",
- "monthNo": 0,
- "manualChange": 0.1,
- "seasonalityPerc": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
], - "nodeDataMomList": [
- {
- "nodeDataMomId": 0,
- "month": "string",
- "startValue": 0.1,
- "endValue": 0.1,
- "calculatedValue": 0.1,
- "calculatedMmdValue": 0.1,
- "difference": 0.1,
- "seasonalityPerc": 0.1,
- "manualChange": 0.1
}
], - "nodeDataExtrapolation": {
- "nodeDataExtapolationId": 0,
- "extrapolationMethod": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "notes": "string",
- "extrapolationDataList": [
- {
- "month": null,
- "amount": null,
- "ci": null,
- "reportingRate": null,
- "manualChange": null
}
]
}, - "nodeDataExtrapolationOptionList": [
- {
- "nodeDataExtapolationOptionId": 0,
- "extrapolationMethod": {
- "id": null,
- "label": null,
- "idString": null
}, - "jsonProperties": {
- "property1": { },
- "property2": { }
}, - "extrapolationOptionDataList": [
- null
], - "jsonPropertiesString": "string"
}
]
}
], - "property2": [
- {
- "nodeDataId": 0,
- "month": "string",
- "monthNo": 0,
- "dataValue": 0.1,
- "calculatedDataValue": 0.1,
- "fuNode": {
- "nodeDataFuId": 0,
- "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "tracerCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "productCategory": {
- "id": null,
- "label": null,
- "idString": null
}, - "idString": "string"
}, - "lagInMonths": 0,
- "usageType": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "noOfPersons": 0,
- "noOfForecastingUnitsPerPerson": 0,
- "oneTimeUsage": true,
- "usageFrequency": 0.1,
- "usagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}, - "repeatCount": 0.1,
- "repeatUsagePeriod": {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
}, - "puNode": {
- "nodeDataPuId": 0,
- "planningUnit": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "unit": {
- "id": null,
- "label": null,
- "code": null,
- "idString": null
}, - "multiplier": 0.1,
- "idString": "string"
}, - "sharePlanningUnit": true,
- "refillMonths": 0,
- "puPerVisit": 0
}, - "extrapolation": true,
- "notes": "string",
- "manualChangesEffectFuture": true,
- "nodeDataModelingList": [
- {
- "nodeDataModelingId": 0,
- "startDate": "string",
- "startDateNo": 0,
- "stopDate": "string",
- "stopDateNo": 0,
- "modelingType": {
- "id": null,
- "label": null,
- "idString": null
}, - "dataValue": 0.1,
- "increaseDecrease": 0,
- "transferNodeDataId": 0,
- "notes": "string"
}
], - "nodeDataOverrideList": [
- {
- "createdBy": {
- "userId": null,
- "username": null
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": null,
- "username": null
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "nodeDataOverrideId": 0,
- "month": "2019-08-24T14:15:22Z",
- "monthNo": 0,
- "manualChange": 0.1,
- "seasonalityPerc": 0.1,
- "baseModel": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "baseModel": null
}
}
], - "nodeDataMomList": [
- {
- "nodeDataMomId": 0,
- "month": "string",
- "startValue": 0.1,
- "endValue": 0.1,
- "calculatedValue": 0.1,
- "calculatedMmdValue": 0.1,
- "difference": 0.1,
- "seasonalityPerc": 0.1,
- "manualChange": 0.1
}
], - "nodeDataExtrapolation": {
- "nodeDataExtapolationId": 0,
- "extrapolationMethod": {
- "id": 0,
- "label": {
- "createdBy": null,
- "createdDate": null,
- "lastModifiedBy": null,
- "lastModifiedDate": null,
- "active": null,
- "labelId": null,
- "label_en": null,
- "label_sp": null,
- "label_fr": null,
- "label_pr": null,
- "baseModel": null
}, - "idString": "string"
}, - "notes": "string",
- "extrapolationDataList": [
- {
- "month": null,
- "amount": null,
- "ci": null,
- "reportingRate": null,
- "manualChange": null
}
]
}, - "nodeDataExtrapolationOptionList": [
- {
- "nodeDataExtapolationOptionId": 0,
- "extrapolationMethod": {
- "id": null,
- "label": null,
- "idString": null
}, - "jsonProperties": {
- "property1": { },
- "property2": { }
}, - "extrapolationOptionDataList": [
- null
], - "jsonPropertiesString": "string"
}
]
}
]
}
}, - "level": 0,
- "sortOrder": "string",
- "payloadId": 0
}
], - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Update Unit
API used to update a Unit
Request Body schema: application/jsonrequired
The Unit object that you want to update
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| unitId | integer <int32> |
object (Label) | |
| unitCode | string |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "unitId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unitCode": "string",
- "dimension": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add Unit
API used to add a Unit
Request Body schema: application/jsonrequired
The Unit object that you want to add
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| unitId | integer <int32> |
object (Label) | |
| unitCode | string |
object (SimpleObject) | |
object (BaseModel) |
Responses
Request samples
- Payload
{- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "unitId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unitCode": "string",
- "dimension": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}Add or Update UsagePeriod
API used to add or update UsagePeriod
Request Body schema: application/jsonrequired
The list of UsagePeriod objects that you want to add or update. If usagePeriodId is null or 0 then it is added if usagePeriodId is not null and non 0 it is updated
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| usagePeriodId | integer <int32> |
object (Label) | |
| convertToMonth | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]Add or Update UsageTemplate
API used to add or update UsageTemplate
Request Body schema: application/jsonrequired
The list of UsageTemplate objects that you want to add or update. If usageTemplateId is null or 0 then it is added if usageTemplateId is not null and non 0 it is updated
object (BasicUser) | |
| createdDate | string <date-time> |
object (BasicUser) | |
| lastModifiedDate | string <date-time> |
| active | boolean |
| usageTemplateId | integer <int32> |
object (Label) | |
| realmId | integer <int32> |
object (SimpleCodeObject) | |
object (SimpleUnitObject) | |
object (SimpleCodeObject) | |
object (SimpleObject) | |
| lagInMonths | integer <int32> |
object (SimpleObject) | |
| noOfPatients | integer <int32> |
| noOfForecastingUnits | integer <int32> |
| oneTimeUsage | boolean |
object (UsagePeriod) | |
| usageFrequencyCount | number <double> |
object (UsagePeriod) | |
| repeatCount | number <double> |
| notes | string |
object (Label) | |
| noOfFUPerPersonPerTime | number <double> |
| noOfFUPerPersonPerMonth | number <double> |
| noOfFURequired | number <double> |
object (BaseModel) |
Responses
Request samples
- Payload
[- {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usageTemplateId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "realmId": 0,
- "program": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "forecastingUnit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "idString": "string"
}, - "unit": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "code": "string",
- "idString": "string"
}, - "tracerCategory": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "lagInMonths": 0,
- "usageType": {
- "id": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "idString": "string"
}, - "noOfPatients": 0,
- "noOfForecastingUnits": 0,
- "oneTimeUsage": true,
- "usageFrequencyUsagePeriod": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "usageFrequencyCount": 0.1,
- "repeatUsagePeriod": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "usagePeriodId": 0,
- "label": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "convertToMonth": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "repeatCount": 0.1,
- "notes": "string",
- "usageInWords": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "labelId": 0,
- "label_en": "string",
- "label_sp": "string",
- "label_fr": "string",
- "label_pr": "string",
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}, - "noOfFUPerPersonPerTime": 0.1,
- "noOfFUPerPersonPerMonth": 0.1,
- "noOfFURequired": 0.1,
- "baseModel": {
- "createdBy": {
- "userId": 0,
- "username": "string"
}, - "createdDate": "2019-08-24T14:15:22Z",
- "lastModifiedBy": {
- "userId": 0,
- "username": "string"
}, - "lastModifiedDate": "2019-08-24T14:15:22Z",
- "active": true,
- "baseModel": { }
}
}
]